<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9"/>
<title>NGUI: UIKeyBinding Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI
   &#160;<span id="projectnumber">3.11.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_u_i_key_binding.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_u_i_key_binding-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UIKeyBinding Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This class makes it possible to activate or select something by pressing a key (such as space bar for example).  
 <a href="class_u_i_key_binding.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for UIKeyBinding:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_u_i_key_binding.png" usemap="#UIKeyBinding_map" alt=""/>
  <map id="UIKeyBinding_map" name="UIKeyBinding_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8388fb0eb6aeb29937169b01a72606dc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8388fb0eb6aeb29937169b01a72606dc"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Action</b> { <b>PressAndClick</b>, 
<b>Select</b>, 
<b>All</b>
 }</td></tr>
<tr class="separator:a8388fb0eb6aeb29937169b01a72606dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a335ade2438db537c7756614173fcee15"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a335ade2438db537c7756614173fcee15"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>Modifier</b> { <br />
&#160;&#160;<b>Any</b>, 
<b>Shift</b>, 
<b>Control</b>, 
<b>Alt</b>, 
<br />
&#160;&#160;<b>None</b>
<br />
 }</td></tr>
<tr class="separator:a335ade2438db537c7756614173fcee15"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab06a6be37cf4c4866ec4ddcc394ab046"><td class="memItemLeft" align="right" valign="top">override string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#ab06a6be37cf4c4866ec4ddcc394ab046">ToString</a> ()</td></tr>
<tr class="memdesc:ab06a6be37cf4c4866ec4ddcc394ab046"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the key binding to its text format.  <a href="#ab06a6be37cf4c4866ec4ddcc394ab046">More...</a><br /></td></tr>
<tr class="separator:ab06a6be37cf4c4866ec4ddcc394ab046"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:af6d14f71a3d854fb40c74679b81d001e"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#af6d14f71a3d854fb40c74679b81d001e">IsBound</a> (KeyCode key)</td></tr>
<tr class="memdesc:af6d14f71a3d854fb40c74679b81d001e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check to see if the specified key happens to be bound to some element.  <a href="#af6d14f71a3d854fb40c74679b81d001e">More...</a><br /></td></tr>
<tr class="separator:af6d14f71a3d854fb40c74679b81d001e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed9e91dc8028811826c3c74993f60b2"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#a7ed9e91dc8028811826c3c74993f60b2">IsModifierActive</a> (Modifier <a class="el" href="class_u_i_key_binding.html#a2b1343133c55b1c73366826b680dec4e">modifier</a>)</td></tr>
<tr class="memdesc:a7ed9e91dc8028811826c3c74993f60b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function that checks whether the required modifier key is active.  <a href="#a7ed9e91dc8028811826c3c74993f60b2">More...</a><br /></td></tr>
<tr class="separator:a7ed9e91dc8028811826c3c74993f60b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa8d6a31af3148a7858cc3e7db529cb2"><td class="memItemLeft" align="right" valign="top">static string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#aaa8d6a31af3148a7858cc3e7db529cb2">GetString</a> (KeyCode <a class="el" href="class_u_i_key_binding.html#a1b9f1237cefd4937625621122a37d651">keyCode</a>, Modifier <a class="el" href="class_u_i_key_binding.html#a2b1343133c55b1c73366826b680dec4e">modifier</a>)</td></tr>
<tr class="memdesc:aaa8d6a31af3148a7858cc3e7db529cb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert the key binding to its text format.  <a href="#aaa8d6a31af3148a7858cc3e7db529cb2">More...</a><br /></td></tr>
<tr class="separator:aaa8d6a31af3148a7858cc3e7db529cb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb209ff45c2e7964f301d11c25013076"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#aeb209ff45c2e7964f301d11c25013076">GetKeyCode</a> (string text, out KeyCode key, out Modifier <a class="el" href="class_u_i_key_binding.html#a2b1343133c55b1c73366826b680dec4e">modifier</a>)</td></tr>
<tr class="memdesc:aeb209ff45c2e7964f301d11c25013076"><td class="mdescLeft">&#160;</td><td class="mdescRight">Given the <a class="el" href="class_u_i_key_binding.html#ab06a6be37cf4c4866ec4ddcc394ab046" title="Convert the key binding to its text format. ">ToString()</a> text, parse it for key and modifier information.  <a href="#aeb209ff45c2e7964f301d11c25013076">More...</a><br /></td></tr>
<tr class="separator:aeb209ff45c2e7964f301d11c25013076"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a191ae481d48bf3ffc3af07baa1c6be27"><td class="memItemLeft" align="right" valign="top">static Modifier&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#a191ae481d48bf3ffc3af07baa1c6be27">GetActiveModifier</a> ()</td></tr>
<tr class="memdesc:a191ae481d48bf3ffc3af07baa1c6be27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the currently active key modifier, if any.  <a href="#a191ae481d48bf3ffc3af07baa1c6be27">More...</a><br /></td></tr>
<tr class="separator:a191ae481d48bf3ffc3af07baa1c6be27"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1b9f1237cefd4937625621122a37d651"><td class="memItemLeft" align="right" valign="top">KeyCode&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#a1b9f1237cefd4937625621122a37d651">keyCode</a> = KeyCode.None</td></tr>
<tr class="memdesc:a1b9f1237cefd4937625621122a37d651"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key that will trigger the binding.  <a href="#a1b9f1237cefd4937625621122a37d651">More...</a><br /></td></tr>
<tr class="separator:a1b9f1237cefd4937625621122a37d651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b1343133c55b1c73366826b680dec4e"><td class="memItemLeft" align="right" valign="top">Modifier&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#a2b1343133c55b1c73366826b680dec4e">modifier</a> = Modifier.Any</td></tr>
<tr class="memdesc:a2b1343133c55b1c73366826b680dec4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modifier key that must be active in order for the binding to trigger.  <a href="#a2b1343133c55b1c73366826b680dec4e">More...</a><br /></td></tr>
<tr class="separator:a2b1343133c55b1c73366826b680dec4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0af4925cc34e5fac3337ebb7ff351263"><td class="memItemLeft" align="right" valign="top">Action&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#a0af4925cc34e5fac3337ebb7ff351263">action</a> = Action.PressAndClick</td></tr>
<tr class="memdesc:a0af4925cc34e5fac3337ebb7ff351263"><td class="mdescLeft">&#160;</td><td class="mdescRight">Action to take with the specified key.  <a href="#a0af4925cc34e5fac3337ebb7ff351263">More...</a><br /></td></tr>
<tr class="separator:a0af4925cc34e5fac3337ebb7ff351263"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:adc517a8a4432858493f2df20f0bb057c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc517a8a4432858493f2df20f0bb057c"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>OnEnable</b> ()</td></tr>
<tr class="separator:adc517a8a4432858493f2df20f0bb057c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ec5879cdb71035c87cdac0ba46fb078"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ec5879cdb71035c87cdac0ba46fb078"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>OnDisable</b> ()</td></tr>
<tr class="separator:a3ec5879cdb71035c87cdac0ba46fb078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14913d632c982d042671a1b3ec36cc92"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#a14913d632c982d042671a1b3ec36cc92">Start</a> ()</td></tr>
<tr class="memdesc:a14913d632c982d042671a1b3ec36cc92"><td class="mdescLeft">&#160;</td><td class="mdescRight">If we're bound to an input field, subscribe to its Submit notification.  <a href="#a14913d632c982d042671a1b3ec36cc92">More...</a><br /></td></tr>
<tr class="separator:a14913d632c982d042671a1b3ec36cc92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb3e33102e6a3160971b51ce4799c164"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#acb3e33102e6a3160971b51ce4799c164">OnSubmit</a> ()</td></tr>
<tr class="memdesc:acb3e33102e6a3160971b51ce4799c164"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ignore the KeyUp message if the input field "ate" it.  <a href="#acb3e33102e6a3160971b51ce4799c164">More...</a><br /></td></tr>
<tr class="separator:acb3e33102e6a3160971b51ce4799c164"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad555dba30a70880e7ebbed6650f2345c"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#ad555dba30a70880e7ebbed6650f2345c">IsModifierActive</a> ()</td></tr>
<tr class="memdesc:ad555dba30a70880e7ebbed6650f2345c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convenience function that checks whether the required modifier key is active.  <a href="#ad555dba30a70880e7ebbed6650f2345c">More...</a><br /></td></tr>
<tr class="separator:ad555dba30a70880e7ebbed6650f2345c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0b2595b825f644de64b5f19d6abbd09"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#aa0b2595b825f644de64b5f19d6abbd09">Update</a> ()</td></tr>
<tr class="memdesc:aa0b2595b825f644de64b5f19d6abbd09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Process the key binding.  <a href="#aa0b2595b825f644de64b5f19d6abbd09">More...</a><br /></td></tr>
<tr class="separator:aa0b2595b825f644de64b5f19d6abbd09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a123b785877148a311d6485998c1b9a33"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a123b785877148a311d6485998c1b9a33"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>OnBindingPress</b> (bool pressed)</td></tr>
<tr class="separator:a123b785877148a311d6485998c1b9a33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa787bcf4328268a49ef37e1620f67875"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa787bcf4328268a49ef37e1620f67875"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>OnBindingClick</b> ()</td></tr>
<tr class="separator:aa787bcf4328268a49ef37e1620f67875"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ad71bfc002d0ffcf778af9335560e0e39"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_key_binding.html#ad71bfc002d0ffcf778af9335560e0e39">captionText</a><code> [get]</code></td></tr>
<tr class="memdesc:ad71bfc002d0ffcf778af9335560e0e39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key binding's descriptive caption.  <a href="#ad71bfc002d0ffcf778af9335560e0e39">More...</a><br /></td></tr>
<tr class="separator:ad71bfc002d0ffcf778af9335560e0e39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class makes it possible to activate or select something by pressing a key (such as space bar for example). </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a191ae481d48bf3ffc3af07baa1c6be27"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Modifier UIKeyBinding.GetActiveModifier </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the currently active key modifier, if any. </p>

</div>
</div>
<a class="anchor" id="aeb209ff45c2e7964f301d11c25013076"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool UIKeyBinding.GetKeyCode </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>text</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">out KeyCode&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">out Modifier&#160;</td>
          <td class="paramname"><em>modifier</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Given the <a class="el" href="class_u_i_key_binding.html#ab06a6be37cf4c4866ec4ddcc394ab046" title="Convert the key binding to its text format. ">ToString()</a> text, parse it for key and modifier information. </p>

</div>
</div>
<a class="anchor" id="aaa8d6a31af3148a7858cc3e7db529cb2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static string UIKeyBinding.GetString </td>
          <td>(</td>
          <td class="paramtype">KeyCode&#160;</td>
          <td class="paramname"><em>keyCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Modifier&#160;</td>
          <td class="paramname"><em>modifier</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convert the key binding to its text format. </p>

</div>
</div>
<a class="anchor" id="af6d14f71a3d854fb40c74679b81d001e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool UIKeyBinding.IsBound </td>
          <td>(</td>
          <td class="paramtype">KeyCode&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Check to see if the specified key happens to be bound to some element. </p>

</div>
</div>
<a class="anchor" id="ad555dba30a70880e7ebbed6650f2345c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool UIKeyBinding.IsModifierActive </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convenience function that checks whether the required modifier key is active. </p>

</div>
</div>
<a class="anchor" id="a7ed9e91dc8028811826c3c74993f60b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool UIKeyBinding.IsModifierActive </td>
          <td>(</td>
          <td class="paramtype">Modifier&#160;</td>
          <td class="paramname"><em>modifier</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Convenience function that checks whether the required modifier key is active. </p>

</div>
</div>
<a class="anchor" id="acb3e33102e6a3160971b51ce4799c164"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void UIKeyBinding.OnSubmit </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Ignore the KeyUp message if the input field "ate" it. </p>

</div>
</div>
<a class="anchor" id="a14913d632c982d042671a1b3ec36cc92"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void UIKeyBinding.Start </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>If we're bound to an input field, subscribe to its Submit notification. </p>

</div>
</div>
<a class="anchor" id="ab06a6be37cf4c4866ec4ddcc394ab046"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">override string UIKeyBinding.ToString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Convert the key binding to its text format. </p>

</div>
</div>
<a class="anchor" id="aa0b2595b825f644de64b5f19d6abbd09"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void UIKeyBinding.Update </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Process the key binding. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0af4925cc34e5fac3337ebb7ff351263"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Action UIKeyBinding.action = Action.PressAndClick</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Action to take with the specified key. </p>

</div>
</div>
<a class="anchor" id="a1b9f1237cefd4937625621122a37d651"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KeyCode UIKeyBinding.keyCode = KeyCode.None</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Key that will trigger the binding. </p>

</div>
</div>
<a class="anchor" id="a2b1343133c55b1c73366826b680dec4e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Modifier UIKeyBinding.modifier = Modifier.Any</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Modifier key that must be active in order for the binding to trigger. </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ad71bfc002d0ffcf778af9335560e0e39"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">string UIKeyBinding.captionText</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Key binding's descriptive caption. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/WorkDir/Unity3D_Work/taidou_arpg/Assets/NGUI/Scripts/Interaction/UIKeyBinding.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_u_i_key_binding.html">UIKeyBinding</a></li>
    <li class="footer">Generated on Sat Jan 4 2020 22:30:28 for NGUI by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9 </li>
  </ul>
</div>
</body>
</html>
